package com.sc.fs3.common;

import java.util.HashMap;

/**
 * 操作消息提醒
 *
 * @author mhg
 */
public class Result extends HashMap<String, Object>
{
    private static final long serialVersionUID = 1L;

    /** 是否成功 */
    public static final String success_TAG = "success";

    /** 返回内容 */
    public static final String MSG_TAG = "msg";

    /** 数据对象 */
    public static final String DATA_TAG = "data";

    /**
     * 初始化一个新创建的 Result 对象，使其表示一个空消息。
     */
    public Result()
    {
    }

    /**
     * 初始化一个新创建的 Result 对象
     *
     * @param success 是否成功
     * @param msg 返回内容
     */
    public Result(boolean success, String msg)
    {
        super.put(success_TAG, success);
        super.put(MSG_TAG, msg);
    }

    /**
     * 初始化一个新创建的 Result 对象
     *
     * @param success 是否成功
     * @param msg 返回内容
     * @param data 数据对象
     */
    public Result(boolean success, String msg, Object data)
    {
        super.put(success_TAG, success);
        super.put(MSG_TAG, msg);
        if (data != null)
        {
            super.put(DATA_TAG, data);
        }
    }

    /**
     * 返回成功消息
     *
     * @return 成功消息
     */
    public static Result ok()
    {
        return Result.ok(null);
    }

    /**
     * 返回成功数据
     *
     * @return 成功消息
     */
    public static Result ok(Object data)
    {
        return Result.ok("操作成功", data);
    }

    /**
     * 返回成功消息
     *
     * @param msg 返回内容
     * @return 成功消息
     */
    public static Result success(String msg)
    {
        return Result.ok(msg, null);
    }

    /**
     * 返回成功消息
     *
     * @param msg 返回内容
     * @param data 数据对象
     * @return 成功消息
     */
    public static Result ok(String msg, Object data)
    {
        return new Result(true, msg, data);
    }

    /**
     * 返回错误消息
     *
     * @return
     */
    public static Result error()
    {
        return Result.error("操作失败");
    }

    /**
     * 返回错误消息
     *
     * @param msg 返回内容
     * @return 警告消息
     */
    public static Result error(String msg)
    {
        return Result.error(msg, null);
    }

    /**
     * 返回错误消息
     *
     * @param msg 返回内容
     * @param data 数据对象
     * @return 警告消息
     */
    public static Result error(String msg, Object data)
    {
        return new Result(false, msg, data);
    }
}

